<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="EzLog,org.flashalchemy.ezlib.ezlog.EzLog,isInitialized,lastKnownFilters,originalFilters,addTarget,arrangeConsoleWindowsHorizontally,arrangeConsoleWindowsVertically,cascadeConsoleWindows,flush,getFilter,getInstance,getLogger,initialize,initializeViaXml,registerFilters,removeTarget,resetLogTarget,swapLogTarget,swapToFirstRegisteredFilters,swapToLastRegisteredFilters" name="keywords">
<title>org.flashalchemy.ezlib.ezlog.EzLog</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'EzLog - EzLog_version_1_0_0';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">EzLog_version_1_0_0 version 1.0.0</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?org/flashalchemy/ezlib/ezlog/EzLog.html&amp;org/flashalchemy/ezlib/ezlog/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;EzLog</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class EzLog"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.flashalchemy.ezlib.ezlog</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public final  class EzLog</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">EzLog <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
</tr>
</table>
<p></p>
          <b>Description: </b>EzLog is a Singleton class providing Singleton access to a dynamically configured ILogger object
     which an application and its various components can utilize for logging/debugging purposes.<br/>
     EzLog should be initialized with a formatted target of type <code>ILoggingTarget</code> so that all EzLog.getLogger() calls
     will be made with a standard formatted target rather than the Flex default.<br/>The flexlogger Standard is to initialize the
     EzLog Singleton from the preinitialize event the main application .mxml file using an ILoggingTarget of type <code>org.flashalchemy.ezlib.logging.targets.EzTraceTarget</code>
     <p/><i>The first line of code that runs in your main application .mxml files should be the initialization of the EzLog.</i> That line of code should look something like this:<p/>
     <code>EzLog.getInstance().initialize(new EzTraceTarget());</code><p/>
     <i>Typically the second line of code that runs in your main application .mxml file is assigning a logger retrieved from the Log to a class property so that your
     main application can make calls to the Log and receive events from the Log.</i><p/>
     Example: <code> logger = EzLog.getLogger(this); </code><p/>
          <b>Usage: </b>EzLog cannot be directly instantiated since it is a class that employs the Singleton design pattern.
     EzLog should be initialized once per application session via the <code>EzLog.getInstance().initialize(logTarget:ILoggingTarget)</code> public method. All subsequent calls to
     <code>EzLog.getInstance().initialize(logTarget:ILoggingTarget)</code> will send and errorneous trace message to the console and no further code will run in that method.</p>
     Once initialized, EzLog should be used via its static API which is described in detail in the method section.
          <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#isInitialized">isInitialized</a> : Boolean<div class="summaryTableDescription">[static][read-only]
         Boolean variable indicating if this Singleton class (EzLog) has been initialized.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#lastKnownFilters">lastKnownFilters</a> : Array<div class="summaryTableDescription">[static][read-only]
         reference to the current qualified filter array registered with this class.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#originalFilters">originalFilters</a> : Array<div class="summaryTableDescription">[static][read-only]
         The filters used when the EzLog was initialized
         </div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#EzLog()">EzLog</a>(access:Private)</div>
<div class="summaryTableDescription">
         This is (simulated) Private constructor, do not directly instantiate this class or an error will be thrown.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addTarget()">addTarget</a>(target:ILoggingTarget):void</div>
<div class="summaryTableDescription">[static]
         Simple wrapper around the static method <code>Log.addTarget(target:ILogger)</code>.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#arrangeConsoleWindowsHorizontally()">arrangeConsoleWindowsHorizontally</a>():void</div>
<div class="summaryTableDescription">[static]
         Horizontally arranges all console windows from the top left conrner, the state of each window will not be changed.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#arrangeConsoleWindowsVertically()">arrangeConsoleWindowsVertically</a>():void</div>
<div class="summaryTableDescription">[static]
         Vertically arranges all console windows from the top left conrner, the state of each window will not be changed.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#cascadeConsoleWindows()">cascadeConsoleWindows</a>():void</div>
<div class="summaryTableDescription">[static]
         Cascades all console windows from the top left conrner, the state of each window will not be changed.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#flush()">flush</a>():void</div>
<div class="summaryTableDescription">[static]
         Simple wrapper around the static method <code>Log.flush()</code>
         </div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getFilter()">getFilter</a>(values:Array):Array</div>
<div class="summaryTableDescription">[static]
         Convert an array of classes or instances to an array of valid
         category names.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getInstance()">getInstance</a>():<a href="../ezlog/EzLog.html">EzLog</a>
</div>
<div class="summaryTableDescription">[static]
         Determines if the singleton instance of EzLog
         has been instantiated.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getLogger()">getLogger</a>(callingObject:*):ILogger</div>
<div class="summaryTableDescription">[static]
         Takes a calling object argument and an ILogger retrieved from the Log using the category name of the calling object is returned.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#initialize()">initialize</a>($logTarget:ILoggingTarget):void</div>
<div class="summaryTableDescription">
         Initializes the Log by flushing the Log and adding the <code>$logTarget</code> to the Log.<p/>
         <i>Note:</i> This method can only be called once, each subsequent call to this method will result in warning message to the IDE console.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#initializeViaXml()">initializeViaXml</a>(xmlFilePath:String):void</div>
<div class="summaryTableDescription">
         Initializes the Log by flushing the Log, loading and parsing a EzLogData .xml file and then configuring the EzLog based on the xml data
         <i>Note:</i> This method can only be called once, each subsequent call to this method will result in a warning message to the IDE console.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#registerFilters()">registerFilters</a>(callingObject:*, qualifiedFilters:Array):ILogger</div>
<div class="summaryTableDescription">[static]
         Sets a filter on the current log target and returns a new instance of the Log.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeTarget()">removeTarget</a>(target:ILoggingTarget):void</div>
<div class="summaryTableDescription">[static]
         Simple wrapper around the static method <code>Log.removeTarget(target:ILogger)</code>.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#resetLogTarget()">resetLogTarget</a>(callingObject:*):ILogger</div>
<div class="summaryTableDescription">[static]
         Flushes the Log and resets the log target for the Log to be the original log target used when this class was initialized (see class description).</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#swapLogTarget()">swapLogTarget</a>(callingObject:*, newLogTarget:ILoggingTarget):ILogger</div>
<div class="summaryTableDescription">[static]
         Flushes the Log then adds the <code>newLogTarget</code> to the Log and returns a new ILogger
                  </div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#swapToFirstRegisteredFilters()">swapToFirstRegisteredFilters</a>(callingObject:*):ILogger</div>
<div class="summaryTableDescription">[static]
         Resets the filters on the current log target to the original filters used when the EzLog was initialized and returns a new instance of the Log.<br/>Use this method
         to reinstate the original filters array to the log target before the Log was flushed.<br/> The public static methods of this class: swaplogTarget(), resetLogTarget(),
         initialize(), and getInstance() all flush the Log when called which will clear out any custom filters (or the original filter) being used at the moment.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#swapToLastRegisteredFilters()">swapToLastRegisteredFilters</a>(callingObject:*):ILogger</div>
<div class="summaryTableDescription">[static]
         Resets the filters on the current log target to the last filters used with that log target and returns a new instance of the Log.<br/>Use this method
         to reinstate the last used filters array before the Log was flushed to the current log target.<br/> The public static methods of this class: swaplogTarget(), resetLogTarget(),
         initialize(), and getInstance() all flush the Log when called which will clear out any custom filters being used at the moment.<br/>
         This method is here so that the last used filter can be recovered if it is flushed away or changed by calling the various EzLog API's.</div>
</td><td class="summaryTableOwnerCol">EzLog</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="isInitialized"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">isInitialized</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>isInitialized:Boolean</code>&nbsp;&nbsp;[read-only]<p>
         Boolean variable indicating if this Singleton class (EzLog) has been initialized.
         Remember that this class (EzLog) should only be initialized once. Somtimes you will use
         this variable to make a check to see if it is safe to initialize this class.
         </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get isInitialized():Boolean</code>
<br>
</div>
<a name="lastKnownFilters"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">lastKnownFilters</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>lastKnownFilters:Array</code>&nbsp;&nbsp;[read-only]<p>
         reference to the current qualified filter array registered with this class.
                  </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get lastKnownFilters():Array</code>
<br>
</div>
<a name="originalFilters"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">originalFilters</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>originalFilters:Array</code>&nbsp;&nbsp;[read-only]<p>
         The filters used when the EzLog was initialized
         </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get originalFilters():Array</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="EzLog()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">EzLog</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function EzLog(access:Private)</code><p>
         This is (simulated) Private constructor, do not directly instantiate this class or an error will be thrown.
                  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">access</span>:Private</code></td>
</tr>
</table>
<br>
<span class="label">Throws</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code></code> &mdash; Generic Error with the message "SINGLETON_EXCEPTION" if any class outside this one tries to instantiate it.
         </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addTarget()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addTarget</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public static function addTarget(target:ILoggingTarget):void</code><p>
         Simple wrapper around the static method <code>Log.addTarget(target:ILogger)</code>. Use this method to add additional targets to the EzLog.
         </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:ILoggingTarget</code></td>
</tr>
</table>
</div>
<a name="arrangeConsoleWindowsHorizontally()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">arrangeConsoleWindowsHorizontally</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function arrangeConsoleWindowsHorizontally():void</code><p>
         Horizontally arranges all console windows from the top left conrner, the state of each window will not be changed.
         Should only be called when there is more than one console active in the program.
         </p></div>
<a name="arrangeConsoleWindowsVertically()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">arrangeConsoleWindowsVertically</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function arrangeConsoleWindowsVertically():void</code><p>
         Vertically arranges all console windows from the top left conrner, the state of each window will not be changed.
         Should only be called when there is more than one console active in the program.
         </p></div>
<a name="cascadeConsoleWindows()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">cascadeConsoleWindows</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function cascadeConsoleWindows():void</code><p>
         Cascades all console windows from the top left conrner, the state of each window will not be changed.
         Should only be called when there is more than one console active in the program.
         </p></div>
<a name="flush()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">flush</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function flush():void</code><p>
         Simple wrapper around the static method <code>Log.flush()</code>
         </p></div>
<a name="getFilter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getFilter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function getFilter(values:Array):Array</code><p>
         Convert an array of classes or instances to an array of valid
         category names.
                  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Array</code> &mdash; of values to be converted to category strings
         </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Array</code> &mdash; array of category strings

         </td>
</tr>
</table>
</div>
<a name="getInstance()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function getInstance():<a href="../ezlog/EzLog.html">EzLog</a></code><p>
         Determines if the singleton instance of EzLog
         has been instantiated.
                  </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../ezlog/EzLog.html">EzLog</a></code> &mdash; 
                        singleton instance of EzLog
         
                        
                     </td>
</tr>
</table>
</div>
<a name="getLogger()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getLogger</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function getLogger(callingObject:*):ILogger</code><p>
         Takes a calling object argument and an ILogger retrieved from the Log using the category name of the calling object is returned.
         The calling object must be passed in manually since the arguments.caller property was removed in Actionscript 3 :(
                  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">callingObject</span>:*</code> &mdash; A reference to the object calling this method.
         </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>ILogger</code> &mdash; a logger specifically for the calling object, use this logger to make calls to the Log.
         </td>
</tr>
</table>
</div>
<a name="initialize()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">initialize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function initialize($logTarget:ILoggingTarget):void</code><p>
         Initializes the Log by flushing the Log and adding the <code>$logTarget</code> to the Log.<p/>
         <i>Note:</i> This method can only be called once, each subsequent call to this method will result in warning message to the IDE console.
         No other code will execute in the method at that point.
                  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">$logTarget</span>:ILoggingTarget</code> &mdash; formatted logging target (aka a 'trace target')
         </td>
</tr>
</table>
</div>
<a name="initializeViaXml()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">initializeViaXml</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function initializeViaXml(xmlFilePath:String):void</code><p>
         Initializes the Log by flushing the Log, loading and parsing a EzLogData .xml file and then configuring the EzLog based on the xml data
         <i>Note:</i> This method can only be called once, each subsequent call to this method will result in a warning message to the IDE console.
         No other code will execute in the method at that point.
         <i>Note:</i> This method can only be called once, each subsequent call to this method will result in a warning message to the IDE console.
         No other code will execute in the method at that point.
                  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">xmlFilePath</span>:String</code> &mdash; path to the EzLogData .xml file
         </td>
</tr>
</table>
</div>
<a name="registerFilters()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">registerFilters</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function registerFilters(callingObject:*, qualifiedFilters:Array):ILogger</code><p>
         Sets a filter on the current log target and returns a new instance of the Log. This method also validates the contents of the array passed in
         and will abort with a trace warning if the array is not valid. Validation is implemented by using the mx.logging.Log.hasIllegalCharacters() API.<br/>
         Use this method to swap filters without having to instantiate and swap to a new log target.
                  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">callingObject</span>:*</code> &mdash; A reference to the object calling this method.
         </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">qualifiedFilters</span>:Array</code> &mdash; An Array of legal category strings, this argument will be validated.
         </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>ILogger</code> &mdash; A new instance of the Logger that sets the passed in array filter used to the current log target.
         </td>
</tr>
</table>
</div>
<a name="removeTarget()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeTarget</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function removeTarget(target:ILoggingTarget):void</code><p>
         Simple wrapper around the static method <code>Log.removeTarget(target:ILogger)</code>. Use this method to remove targets from the EzLog.
         </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:ILoggingTarget</code></td>
</tr>
</table>
</div>
<a name="resetLogTarget()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">resetLogTarget</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function resetLogTarget(callingObject:*):ILogger</code><p>
         Flushes the Log and resets the log target for the Log to be the original log target used when this class was initialized (see class description).
         If this class has not been initialized then a <code>null</code> log target will be used.
                  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">callingObject</span>:*</code> &mdash; A reference to the object calling this method.
         </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>ILogger</code> &mdash; a ILogger instance that uses the logTarget that was passed in when This Singleton class was initialized (see class description).
         </td>
</tr>
</table>
</div>
<a name="swapLogTarget()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">swapLogTarget</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function swapLogTarget(callingObject:*, newLogTarget:ILoggingTarget):ILogger</code><p>
         Flushes the Log then adds the <code>newLogTarget</code> to the Log and returns a new ILogger
                  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">callingObject</span>:*</code> &mdash; The calling object to be registered to the Log
         </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">newLogTarget</span>:ILoggingTarget</code> &mdash; The Log target to be adeded to the ILogger that is returned
         </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>ILogger</code> &mdash; a new ILogger registered to the callingObject (given the new log target is configured to do so)
         </td>
</tr>
</table>
</div>
<a name="swapToFirstRegisteredFilters()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">swapToFirstRegisteredFilters</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function swapToFirstRegisteredFilters(callingObject:*):ILogger</code><p>
         Resets the filters on the current log target to the original filters used when the EzLog was initialized and returns a new instance of the Log.<br/>Use this method
         to reinstate the original filters array to the log target before the Log was flushed.<br/> The public static methods of this class: swaplogTarget(), resetLogTarget(),
         initialize(), and getInstance() all flush the Log when called which will clear out any custom filters (or the original filter) being used at the moment.
         This method is here so that the original filter used to initialize this class can be recovered if it is flushed or changed away by calling swaplogTarget(),
         resetLogTarget(), initialize(), registerFilters() or getInstance().
                  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">callingObject</span>:*</code> &mdash; A reference to the object calling this method.
         </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>ILogger</code> &mdash; A new instance of the Logger that sets the original filter used (for the orginal log target that was used) to the current log target.
         </td>
</tr>
</table>
</div>
<a name="swapToLastRegisteredFilters()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">swapToLastRegisteredFilters</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function swapToLastRegisteredFilters(callingObject:*):ILogger</code><p>
         Resets the filters on the current log target to the last filters used with that log target and returns a new instance of the Log.<br/>Use this method
         to reinstate the last used filters array before the Log was flushed to the current log target.<br/> The public static methods of this class: swaplogTarget(), resetLogTarget(),
         initialize(), and getInstance() all flush the Log when called which will clear out any custom filters being used at the moment.<br/>
         This method is here so that the last used filter can be recovered if it is flushed away or changed by calling the various EzLog API's.
                  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">callingObject</span>:*</code> &mdash; A reference to the object calling this method.
         </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>ILogger</code> &mdash; A new instance of the Logger that sets the last known filter used to the current log target.
         </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
